/*
 * Copyright (c) 2007 Open Kernel Labs, Inc. (Copyright Holder).
 * All rights reserved.
 *
 * 1. Redistribution and use of OKL4 (Software) in source and binary
 * forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *
 *     (a) Redistributions of source code must retain this clause 1
 *         (including paragraphs (a), (b) and (c)), clause 2 and clause 3
 *         (Licence Terms) and the above copyright notice.
 *
 *     (b) Redistributions in binary form must reproduce the above
 *         copyright notice and the Licence Terms in the documentation and/or
 *         other materials provided with the distribution.
 *
 *     (c) Redistributions in any form must be accompanied by information on
 *         how to obtain complete source code for:
 *        (i) the Software; and
 *        (ii) all accompanying software that uses (or is intended to
 *        use) the Software whether directly or indirectly.  Such source
 *        code must:
 *        (iii) either be included in the distribution or be available
 *        for no more than the cost of distribution plus a nominal fee;
 *        and
 *        (iv) be licensed by each relevant holder of copyright under
 *        either the Licence Terms (with an appropriate copyright notice)
 *        or the terms of a licence which is approved by the Open Source
 *        Initative.  For an executable file, "complete source code"
 *        means the source code for all modules it contains and includes
 *        associated build and other files reasonably required to produce
 *        the executable.
 *
 * 2. THIS SOFTWARE IS PROVIDED ``AS IS'' AND, TO THE EXTENT PERMITTED BY
 * LAW, ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED.  WHERE ANY WARRANTY IS
 * IMPLIED AND IS PREVENTED BY LAW FROM BEING DISCLAIMED THEN TO THE
 * EXTENT PERMISSIBLE BY LAW: (A) THE WARRANTY IS READ DOWN IN FAVOUR OF
 * THE COPYRIGHT HOLDER (AND, IN THE CASE OF A PARTICIPANT, THAT
 * PARTICIPANT) AND (B) ANY LIMITATIONS PERMITTED BY LAW (INCLUDING AS TO
 * THE EXTENT OF THE WARRANTY AND THE REMEDIES AVAILABLE IN THE EVENT OF
 * BREACH) ARE DEEMED PART OF THIS LICENCE IN A FORM MOST FAVOURABLE TO
 * THE COPYRIGHT HOLDER (AND, IN THE CASE OF A PARTICIPANT, THAT
 * PARTICIPANT). IN THE LICENCE TERMS, "PARTICIPANT" INCLUDES EVERY
 * PERSON WHO HAS CONTRIBUTED TO THE SOFTWARE OR WHO HAS BEEN INVOLVED IN
 * THE DISTRIBUTION OR DISSEMINATION OF THE SOFTWARE.
 *
 * 3. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR ANY OTHER PARTICIPANT BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef MEM_POOL_H
#define MEM_POOL_H

#include <limits.h>
#include <stddef.h>
#include <stdint.h>
#include <queue/tailq.h>

#include <stdio.h>

#define MEM_MIN_BITS            12
#define MEM_MIN_SIZE            (1UL << MEM_MIN_BITS)
#define MEM_MAX_IDX             (sizeof(addr_t) * CHAR_BIT - MEM_MIN_BITS)

typedef uintptr_t addr_t;

struct memory {
    addr_t addr;
    size_t size;
    TAILQ_ENTRY(memory) mem_list;
};

TAILQ_HEAD(mem_list, memory);

struct mem_pool {
    struct mem_list free_list[MEM_MAX_IDX + 1];
    struct mem_list allocated;
    int coalesced;
};

extern struct mem_pool *internal_physpool;
extern struct mem_pool *internal_virtpool;

/*
 * General purpose functions.
 */
struct memory *mem_alloc(struct mem_pool *pool, size_t size);
struct memory *mem_alloc_fixed(struct mem_pool *pool, size_t size, addr_t addr);
void mem_free(struct mem_pool *pool, struct memory *mem);

/*
 * Specialised functions.
 */
int mem_add(struct mem_pool *pool, addr_t addr, size_t size);
struct memory *mem_add_and_alloc(struct mem_pool *pool, addr_t addr, size_t size);
int mem_remove(struct mem_pool *pool, addr_t addr, size_t size);
uintptr_t mem_alloc_unboxed(struct mem_pool *pool, size_t size);
void mem_coalesce(struct mem_pool *pool);
int mem_empty(struct mem_pool *pool);
void __mem_pool_init(uintptr_t vbase, uintptr_t pbase, size_t size);
void mem_clear(struct mem_pool *pool);

#endif
